Skip to content

Commit 151d3ed

Browse files
author
David Wilcox
committed
Updated README
1 parent 8d42510 commit 151d3ed

File tree

2 files changed

+94
-16
lines changed

2 files changed

+94
-16
lines changed

‎README.md

+93-14
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,101 @@
1-
# jlox
2-
A Java implementation of the Lox programming language. This is directly from
3-
Bob Nystrom's site [Crafting Interpreters](https://github.com/bigangryguy/jlox.git).
1+
<!-- PROJECT LOGO -->
2+
<p align="center">
3+
<h3 align="center">jlox</h3>
4+
<p align="center">
5+
Java implementation of the Lox programming language
6+
<br />
7+
<a href="https://github.com/bigangryguy/jlox"><strong>Explore the docs »</strong></a>
8+
<br />
9+
<br />
10+
<a href="https://github.com/bigangryguy/jlox/issues">Report Bug</a>
11+
·
12+
<a href="https://github.com/bigangryguy/jlox/issues">Request Feature</a>
13+
</p>
14+
</p>
415

16+
17+
18+
<!-- TABLE OF CONTENTS -->
19+
## Table of Contents
20+
21+
* [About the Project](#about-the-project)
22+
* [Built With](#built-with)
23+
* [Getting Started](#getting-started)
24+
* [Prerequisites](#prerequisites)
25+
* [Installation](#installation)
26+
* [Usage](#usage)
27+
* [Roadmap](#roadmap)
28+
* [Contributing](#contributing)
29+
* [License](#license)
30+
* [Contact](#contact)
31+
* [Acknowledgements](#acknowledgements)
32+
33+
34+
35+
<!-- ABOUT THE PROJECT -->
36+
## About The Project
37+
38+
A Java implementation of the Lox programming language. This is directly from Bob Nystrom's site [Crafting Interpreters](https://github.com/bigangryguy/jlox.git).
39+
40+
<!-- GETTING STARTED -->
541
## Getting Started
6-
Download the code. It uses fairly basic and generic Java (because I'm not a Java
7-
developer) and was created in IntelliJ IDEA. For a better understanding of the code
8-
itself and the Lox language, read the [Crafting Interpreters](https://github.com/bigangryguy/jlox.git)
9-
site.
1042

43+
To get a local copy up and running follow these simple steps.
44+
45+
### Prerequisites
46+
47+
None. This will work with Java 8 or higher.
48+
49+
### Installation
50+
51+
Clone the repo
52+
```sh
53+
git clone https://github.com/bigangryguy/jlox.git
54+
```
55+
56+
<!-- USAGE EXAMPLES -->
57+
## Usage
58+
59+
For now, reference the Lox grammar [appendix](https://craftinginterpreters.com/appendix-i.html) on the Crafting Interpreters site. In the future, as cloxplus adds new
60+
features and forks from the original language specification, a full grammar reference will be included here.
61+
62+
63+
64+
<!-- ROADMAP -->
65+
## Roadmap
66+
67+
See the [open issues](https://github.com/bigangryguy/jlox/issues) for a list of proposed features (and known issues).
68+
69+
This is a completion of the project. A continued implementation of the Lox language in C++, with plans for extensions
70+
to the original language specification, can be found in my [cloxplus](https://github.com/bigangryguy/cloxplus) project.
71+
72+
73+
<!-- CONTRIBUTING -->
1174
## Contributing
12-
As with all of my simple learning projects, just fork it.
1375

14-
## Authors
15-
* __David Wilcox__ - *All work to this point* - [@davidtwilcox](https://twitter.com/davidtwilcox)
76+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
77+
78+
1. Fork the Project
79+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
80+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
81+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
82+
5. Open a Pull Request
1683

84+
<!-- LICENSE -->
1785
## License
18-
This project is licensed under the MIT license - see the LICENSE.md file for details.
1986

20-
## Acknowledgments
21-
Thank you to Bob Nystrom ([@munificentbob](https://twitter.com/munificentbob)) for the wonderful tutorial on crafting interpreters.
22-
Read his site. Also read his book *Game Programming Patterns* if you're into that kind of thing.
87+
Distributed under the MIT License. See `LICENSE.md` for more information.
88+
89+
<!-- CONTACT -->
90+
## Contact
91+
92+
David Wilcox - [@davidtwilcox](https://twitter.com/davidtwilcox) - [email protected]
93+
94+
Project Link: [https://github.com/bigangryguy/jlox](https://github.com/bigangryguy/jlox)
95+
96+
97+
98+
<!-- ACKNOWLEDGEMENTS -->
99+
## Acknowledgements
100+
101+
* [Bob Nystrom](https://twitter.com/munificentbob) - Author of [Crafting Interpreters](https://craftinginterpreters.com/)

‎jlox.iml

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,4 @@
88
<orderEntry type="inheritedJdk" />
99
<orderEntry type="sourceFolder" forTests="false" />
1010
</component>
11-
</module>
12-
11+
</module>

0 commit comments

Comments
 (0)