Skip to content

Commit 9bcf0e7

Browse files
authored
Merge pull request #327 from CohenArthur/update-readme-0.2.0
readme: Update for 0.2.0
2 parents 9251fa5 + 9438cdf commit 9bcf0e7

File tree

1 file changed

+41
-16
lines changed

1 file changed

+41
-16
lines changed

README.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,40 +23,63 @@ Feel free to come and chat about jinko on [matrix](https://matrix.to/#/#jinko-la
2323

2424
## Programming in jinko
2525

26-
The lib standard is currently inexistant. `0.1.0` serves as a staple release, in
27-
order to validate the design and the possibilities of the language.
26+
The standard library is currently very small! It implements basic utilites such as an
27+
optional type or a string library.
28+
29+
Pull requests aiming at enhancing the stdlib are *very* welcome!
2830

2931
## Installation
3032

31-
For now, installing jinko requires to use cargo's included package manager:
33+
### Installing from the release page
34+
35+
- Download a release tarball from the [releases page](https://github.com/CohenArthur/jinko/releases)
36+
- Extract it somewhere temporarily: `tar xzf jinko-vx.x.x.tar.gz`
37+
38+
You can even use `/tmp/` or any directory that you'll remove later. Every important file
39+
will be copied to its proper location.
40+
41+
- Run `./install.sh`
42+
This will create a `.jinko` folder in your home directory, in which the binary and libraries
43+
will get installed.
3244

33-
`cargo install --git https://github.com/cohenarthur/jinko`
34-
will net you the latest version from git, using the `master` branch. This branch should
35-
always be stable.
45+
### Installing from source
3646

37-
`cargo install jinko` will give you the latest release from `crates.io`. This is equivalent
38-
to downloading a release from the [release page](https://github.com/cohenarthur/jinko/releases)
47+
- Simply run `./install.sh`
48+
This will compile the interpreter in release mode and install it. A `.jinko` folder
49+
will be created in your home directory, in which the binary and libraries
50+
will get installed.
3951

40-
Once releases start getting interesting, packages for various distributions and
41-
systems will be added, as well as a crate on `crates.io`
52+
Do not forget to add `$HOME/.jinko/bins` to your path! This will enable you to launch
53+
`jinko` from anywhere.
54+
55+
While `jinko` is not yet available through various distribution package managers, we'd
56+
love to have this!
57+
58+
## Running
4259

4360
Launch the REPL using `jinko` or run a file using `jinko <file>`!
4461

62+
You can use various command line options. They are available when running `jinko -h`
63+
64+
## Contributing
65+
4566
Feel free to submit any observations, bug reports or questions as an [issue](https://github.com/cohenarthur/jinko/issues)
4667

68+
Checkout [CONTRIBUTING.md](CONTRIBUTING.md)if you'd like to write some code!
69+
70+
The code is organized according to the structure defined in [ARCHITECTURE.md](ARCHITECTURE.md).
71+
72+
I am open to mentoring requests and would love to assist you in getting started on the
73+
language.
74+
4775
## Testing
4876

4977
To test jinko, simply run `cargo test && ./tests/func_tests.sh`. Note that in
5078
order to run functional tests, you need to have [ft installed](https://github.com/CohenArthur/ft#installation)
5179

52-
## Contributing
53-
54-
Checkout [CONTRIBUTING.md](CONTRIBUTING.md)!
55-
5680
## Requirements
5781

5882
* [ ] If a function does not return `void`, its return value should always be used.
59-
* [ ] You can wrap unsound code in `audit` blocks, to make it easier to review.
6083
* [x] Variables are immutable by default.
6184
* [ ] Tests should be an integral part of the language
6285
* [ ] This includes unit testing
@@ -65,13 +88,15 @@ Checkout [CONTRIBUTING.md](CONTRIBUTING.md)!
6588

6689
Check out jinko's [syntax](SYNTAX.md)!
6790

68-
For more information about how jinko is made, checkout its [design](DESIGN.md).
91+
For more information about how jinko is made, check out its [design](DESIGN.md).
6992

7093
## Thanks to
7194

7295
- [Skallwar](https://github.com/skallwar)
7396
- [SanderJSA](https://github.com/sanderjsa)
97+
- [n1tram1](https://github.com/n1tram1)
7498
- [jh2k2](https://github.com/jh2k2)
99+
- [IFcoltransG](https://github.com/ifcoltransg)
75100

76101
## License
77102

0 commit comments

Comments
 (0)