Skip to content

Commit 5a83af1

Browse files
authored
Finalized release version. (#10)
1 parent 6b916d3 commit 5a83af1

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
[package]
22
name = "chemcreator"
3-
version = "0.2.0"
3+
version = "1.0.0"
44
description = "A text-based tool for identifying organic molecules."
55
authors = ["Gavin Tran"]
66
readme = "README.md"
77
license-file = "LICENSE"
88
edition = "2021"
99
repository = "https://github.com/pumken/chemcreator"
1010

11-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
12-
1311
[dependencies]
1412
ruscii = "0.3.2"
1513
thiserror = "1.0.38"

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ A text-based tool for identifying organic molecules.
1111
Written in Rust with the [`ruscii`](https://github.com/lemunozm/ruscii) library.
1212
</div>
1313

14+
## Preface
15+
16+
ChemCreator is a program you can open in your terminal to generate the name of
17+
an organic molecule. You recreate the structure in a grid, manually inputting
18+
atoms and bonds by using your keyboard. When a valid molecule is found,
19+
ChemCreator will try its best to give you the molecule's IUPAC systematic name.
20+
21+
ChemCreator is a personal project that I started to explore the Rust programming
22+
language and also try out a moderately difficult problem in traversing a grid to
23+
find certain structures, determine patterns, etc.
24+
25+
It's not perfect; it may get a few names wrong here and there at times, so if
26+
you try it out and find something named incorrectly, please open an issue!
27+
1428
## Features
1529

1630
- [x] Easy-to-use text-based UI
@@ -21,10 +35,10 @@ Written in Rust with the [`ruscii`](https://github.com/lemunozm/ruscii) library.
2135
- [x] Alkanes
2236
- [x] Alkenes
2337
- [x] Alkynes
24-
- [ ] Alcohols
38+
- [x] Alcohols
2539
- [ ] Aldehydes
26-
- [ ] Carboxylic acids
40+
- [x] Carboxylic acids
2741
- [ ] Ethers
28-
- [ ] Ketones
42+
- [x] Ketones
2943
- [ ] Halogenoalkanes
3044
- [ ] Esters

0 commit comments

Comments
 (0)