Skip to content

Commit

Permalink
📜 README
Browse files Browse the repository at this point in the history
  • Loading branch information
KingPr0o7 committed Mar 27, 2024
1 parent f7e715a commit cd00793
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<p align="center"><img src="stoichify_paper_logo.png?raw=true" alt="Stoichify - Your go-to Stoichiometric solver."></p>

<h1 align="center">Stoichify - The Stoichiometry Solver</h1>

A Python-powered logical system designed to solve stoichiometric equations, by breaking down each step (with explanations!) to build needed knowledge — all for free. Stoichify is open-source and aimed at students and teachers to learn and better their experience with the daunting complexity of stoichiometry.

## Versions

### `v1.0.0`
The initial release of Stoichify, being a Computer Science II project, being a command-line interface (CLI) application only solving mole-mole equations.

### `v2.0.0`
**DESCRIPTION NEEDED**.

## Installation
**EXPLAIN INSTALLATION STEPS NEEDED**

## User Manual
**EXPLAIN HOW TO USE THE APPLICATION**

## License
Due to the nature of this project, and how capable it'll be, this project will be protected by the [`GNU Affero General Public License Version 3 (AGPL-3.0)`](./LICENSE). Intended to yield further projects to be **open source for the public**. Entities are *free to change and upload Stoichify else-where* — as long as it's instilled via [AGPL-3.0](./LICENSE).

<p align="center"><img src="np_logo.png?raw=true" alt="Nathan Parker's Logo"></p>
Binary file added np_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added stoichify_paper_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd00793

Please sign in to comment.