Skip to content

Commit 30c0c9b

Browse files
docs: condensed/simplified README.md (#193)
1 parent 0222fba commit 30c0c9b

File tree

2 files changed

+4
-33
lines changed

2 files changed

+4
-33
lines changed

README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,12 @@ The [Monkey](https://monkeylang.org/) programming language was devised by Thorst
1515

1616
Monkey has a C-like syntax, supports **variable bindings**, **prefix** and **infix operators**, has **first-class** and **higher-order functions**, can handle **closures** with ease and has **integers**, **booleans**, **arrays** and **hashes** built-in.
1717

18-
19-
## Content
20-
* [Usage](#usage)
21-
* [Compiling](#compiling)
22-
* [Unit Testing](#unit-testing)
23-
* [Issues/Feature Requests](#issuesfeature-requests)
24-
25-
2618
## Usage
2719
Run the interpreter via
2820

2921
```sh
3022
monkey_interpreter
3123
```
3224

33-
34-
35-
## Compiling
36-
Checkout the code repository locally, change into the repository's directory and then build via Cargo.
37-
Using the `--release` flag produces an optimised binary but takes longer to compile.
38-
39-
```sh
40-
git clone [email protected]:DeveloperC286/monkey_interpreter.git
41-
cd monkey_interpreter/
42-
cargo build --release
43-
```
44-
45-
The compiled binary is present in `target/release/monkey_interpreter`.
46-
47-
48-
## Unit Testing
49-
The unit test suite has several parameterised tests, Cargo is used to set up and run all the unit tests.
50-
51-
```sh
52-
cargo test
53-
```
54-
55-
5625
## Issues/Feature Requests
5726
To report a bug/issue or request a new feature use [https://github.com/DeveloperC286/monkey_interpreter/issues](https://github.com/DeveloperC286/monkey_interpreter/issues).

src/main.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,18 @@ mod lexical_analysis;
1818
mod syntax_analysis;
1919

2020
fn main() {
21-
info!("Version {}.", env!("CARGO_PKG_VERSION"));
2221
let arguments = Arguments::parse();
23-
debug!("The command line arguments provided are {arguments:?}.");
2422

2523
// Set up logging: if verbose is true and RUST_LOG is not set, default to info level
2624
if arguments.verbose && std::env::var("RUST_LOG").is_err() {
2725
std::env::set_var("RUST_LOG", "info");
2826
}
2927

3028
pretty_env_logger::init();
29+
30+
info!("Version {}.", env!("CARGO_PKG_VERSION"));
31+
debug!("The command line arguments provided are {arguments:?}.");
32+
3133
let mut evaluator = crate::evaluator::Evaluator::new();
3234

3335
loop {

0 commit comments

Comments
 (0)