Skip to content

Commit c3c7723

Browse files
committed
Edit README
1 parent c2ef42f commit c3c7723

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

+19-28
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,35 @@
1-
# clojure-noob
1+
# Clojure Studies
22

3-
FIXME: description
3+
In this repository you'll find exercises and notes I've been taking while reading [**Clojure for The Brave and True**](https://www.braveclojure.com). You'll also find my personal solutions to [**4ever-clojure**](https://4clojure.oxal.org)'s exercises.
44

55
## Installation
66

7-
Download from http://example.com/FIXME.
7+
1. In order to run this project you must have the Java Runtime Environment (JRE) or Java Development Kit (JDK) installed, which you can download [**here**](https://www.oracle.com/java/technologies/downloads/).
8+
2. You should also install [**Leiningen**](https://leiningen.org/), which requires Java.
9+
3. Clone this repository. There are different ways you can do this:
810

9-
## Usage
10-
11-
FIXME: explanation
11+
- If you have `git` installed, use the following command:
12+
```
13+
$ git clone https://github.com/kdmoreira/brave-clojure.git
14+
```
15+
- If you don't have `git` installed, simply download the `.zip` file by clicking on the button "*Clone*" in the repository's homepage.
1216

13-
$ java -jar clojure-noob-0.1.0-standalone.jar [args]
14-
15-
## Options
17+
## Usage
1618

17-
FIXME: listing of options this app accepts.
19+
Open the project folder in your computer and type in your terminal:
1820

19-
## Examples
21+
$ lein run
2022

21-
...
23+
The sentence `I'm a little teapot!` should appear. If it did, success!
2224

23-
### Bugs
25+
## Options
2426

25-
...
27+
You may use the REPL by typing in your terminal:
2628

27-
### Any Other Sections
28-
### That You Think
29-
### Might be Useful
29+
$ lein repl
3030

3131
## License
3232

33-
Copyright © 2022 FIXME
34-
35-
This program and the accompanying materials are made available under the
36-
terms of the Eclipse Public License 2.0 which is available at
37-
http://www.eclipse.org/legal/epl-2.0.
33+
MIT License
3834

39-
This Source Code may also be made available under the following Secondary
40-
Licenses when the conditions for such availability set forth in the Eclipse
41-
Public License, v. 2.0 are satisfied: GNU General Public License as published by
42-
the Free Software Foundation, either version 2 of the License, or (at your
43-
option) any later version, with the GNU Classpath Exception which is available
44-
at https://www.gnu.org/software/classpath/license.html.
35+
Copyright © 2022

0 commit comments

Comments
 (0)