Skip to content

Commit 39b31e5

Browse files
committed
A new README template and use it for Lua, Python, and JavaScript
1 parent 2dce9e9 commit 39b31e5

File tree

3 files changed

+31
-31
lines changed

3 files changed

+31
-31
lines changed

js/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
JavaScript is already installed in every modern web browser. To develop command line scripts and servers, download and install Node.js from the [Node home page](https://nodejs.org) or use your favorite package manager.
66

7-
Once installed, programs in this folder can be run from the command line like so:
7+
Programs in this folder can be run from the command line like so:
88

99
```
1010
node triple.js
@@ -20,11 +20,7 @@ node top_ten_scorers.js < ../test/wnba_input
2020

2121
Running the command `node` with no arguments gives you a repl.
2222

23-
To run the tests on a Unix-like shell:
24-
25-
```
26-
./test.sh
27-
```
23+
Tests can be run with `test.sh` or `test.ps1`.
2824

2925
Note that this folder contains the file **package.json** to enable each of the command line **.js** files to run as _module_ scripts, rather than _classic_ scripts. Modules are the preferred way to write JavaScript, as they enable a host of newer modern features and are much more safe and secure. For the differences between scripts and modules, see [this article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) from MDN’s JavaScript Guide.
3026

@@ -36,17 +32,21 @@ JavaScript is a modern, expressive, dynamic, event-driven programming language t
3632

3733
Continue your study of JavaScript via:
3834

39-
- [Awesome JavaScript](https://github.com/sorrycc/awesome-javascript)
40-
- Another [Awesome JavaScript](https://js.libhunt.com/)
4135
- [The Official Language Specification](https://tc39.es/ecma262/)
4236
- [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web)
37+
- [Awesome JavaScript](https://github.com/sorrycc/awesome-javascript)
38+
- Another [Awesome JavaScript](https://js.libhunt.com/)
4339
- [Axel Rauschmayer's Books](https://exploringjs.com/)
4440
- [Axel Rauschmayer's Blog](http://www.2ality.com/)
41+
- [JavaScript at Rosetta Code](https://rosettacode.org/wiki/Category:JavaScript)
4542

46-
## JavaScript Open Source Projects
43+
## JavaScript in Open Source
4744

48-
Studying, and contributing to, open source projects is an excellent way to improve your proficiency in any language. Of the many projects using JavaScript, you may enjoy:
45+
You may enjoy:
4946

47+
- [The GitHub Topic Page](https://github.com/topics/javascript)
48+
- [Trending Lua Repositories on GitHub](https://github.com/trending/javascript)
49+
- [Top 100 Starred Lua Repositories on GitHub](https://github.com/EvanLi/Github-Ranking/blob/master/Top100/JavaScript.md)
5050
- [React](https://github.com/facebook/react)
5151
- [d3](https://github.com/mbostock/d3)
5252
- [date-fns](https://github.com/date-fns/date-fns)

lua/README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# Lua Explorations
44

5-
To build and run Lua programs on your local machine, download and install the Lua system from the [Lua downloads page](https://www.lua.org/download.html) or use your favorite package manager.
5+
To build and run Lua programs on your local machine, download and install the most recent language version from the [Lua downloads page](https://www.lua.org/download.html) or use your favorite package manager.
66

7-
Once installed, programs in this folder can be run from the command line like so:
7+
Programs in this folder can be run from the command line like so:
88

99
```
1010
lua triple.lua
@@ -20,32 +20,30 @@ lua top_ten_scorers.lua < ../test/wnba_input
2020

2121
Running the command `lua` with no arguments gives you a repl.
2222

23-
To run the tests on a Unix-like shell:
24-
25-
```
26-
./test.sh
27-
```
23+
Tests can be run with `test.sh` or `test.ps1`.
2824

2925
## About Lua
3026

31-
Lua is a lightweight and efficient programming language. It was designed and implemented by a team led by Roberto Ierusalimschy at PUC-Rio, Pontifícia Universidade Católica do Rio de Janeiro, in Brazil. The first version of Lua was released in 1993 and it is still being actively developed today. Lua is a popular choice for game programming and was the implementation language for titles such as World of Warcraft, Angry Birds, Hades II, Diner Dash, Roblox, and SimCity 4. It interoperates well with other languages, and can easily be embedded into C, C++, Java, Fortran, Smalltalk, and Erlang implementations.
27+
Lua is a lightweight and efficient programming language. It was designed and implemented by a team led by Roberto Ierusalimschy at PUC-Rio, Pontifícia Universidade Católica do Rio de Janeiro, in Brazil. The first version of Lua was released in 1993 and the language is still being actively developed. Lua is a popular choice for game programming and was the implementation language for titles such as World of Warcraft, Angry Birds, Hades II, Diner Dash, Roblox, and SimCity 4. It interoperates well with other languages, and can easily be embedded into C, C++, Java, Fortran, Smalltalk, and Erlang implementations.
3228

3329
## Lua Resources
3430

3531
Continue your study of Lua via:
3632

37-
- [Awesome Lua](https://github.com/LewisJEllis/awesome-lua)
3833
- [Lua Home](http://www.lua.org/)
34+
- [Official Documentation](http://www.lua.org/docs.html)
3935
- [List of Lua Books](http://www.lua.org/docs.html#books)
40-
- [Lua Reference Manual](http://www.lua.org/manual/)
4136
- The book [_Programming in Lua_](http://www.lua.org/pil/) by Lua’s creator, Roberto Ierusalimschy
37+
- [Awesome Lua](https://github.com/uhub/awesome-lua)
4238
- [List of Lua Books](https://realtoughcandy.com/best-lua-books/)
4339
- [List of video games scripted in Lua](<https://en.wikipedia.org/wiki/Category:Lua_(programming_language)-scripted_video_games>)
40+
- [Lua at Rosetta Code](https://rosettacode.org/wiki/Category:Lua)
4441

45-
## Lua Open Source Projects
42+
## Lua in Open Source
4643

47-
Studying, and contributing to, open source projects is an excellent way to improve your proficiency in any language. Of the many projects using Lua, you may enjoy:
44+
You may enjoy:
4845

46+
- [The GitHub Topic Page](https://github.com/topics/lua)
4947
- [Trending Lua Repositories on GitHub](https://github.com/trending/lua)
5048
- [Top 100 Starred Lua Repositories on GitHub](https://github.com/EvanLi/Github-Ranking/blob/master/Top100/Lua.md)
5149
- [Luvit](https://github.com/luvit/luvit)

python/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
To build and run Python programs on your local machine, download and install the most recent language version from the [Python home page](https://www.python.org/) or use your favorite package manager.
66

7-
Once installed, programs in this folder can be run from the command line like so:
7+
Programs in this folder can be run from the command line like so:
88

99
```
1010
python3 triple.py
@@ -20,11 +20,9 @@ python3 top_ten_scorers.py < ../test/wnba_input
2020

2121
Running the command `python3` with no arguments gives you a repl.
2222

23-
To run the tests on a Unix-like shell:
23+
If you, as you may have already, are using virtual environments or have aliased `python3` to `python`, you may replace `python3` with `python` in the above commands.
2424

25-
```
26-
./test.sh
27-
```
25+
Tests can be run with `test.sh` or `test.ps1`.
2826

2927
## About Python
3028

@@ -34,16 +32,20 @@ Python is a powerful and expressive programming language that “lets you work q
3432

3533
Continue your study of Python via:
3634

37-
- [Awesome Python](https://github.com/vinta/awesome-python)
3835
- [Python Home](https://www.python.org/)
39-
- [Python Docs Home](https://www.python.org/doc/)
36+
- [Official Documentation](https://www.python.org/doc/)
37+
- [Awesome Python](https://github.com/vinta/awesome-python)
4038
- [A curated list of Python books](https://wiki.python.org/moin/PythonBooks)
4139
- [An online Python course](https://developers.google.com/edu/python/)
40+
- [Python at Rosetta Code](https://rosettacode.org/wiki/Category:Python)
4241

43-
## Python Open Source Projects
42+
## Python in Open Source
4443

45-
Studying, and contributing to, open source projects is an excellent way to improve your proficiency in any language. Of the many projects using Python, you may enjoy:
44+
You may enjoy:
4645

46+
- [The GitHub Topic Page](https://github.com/topics/python)
47+
- [Trending Lua Repositories on GitHub](https://github.com/trending/python)
48+
- [Top 100 Starred Lua Repositories on GitHub](https://github.com/EvanLi/Github-Ranking/blob/master/Top100/Python.md)
4749
- [Requests](https://github.com/kennethreitz/requests)
4850
- [Flask](https://github.com/mitsuhiko/flask)
4951
- [Reddit](https://github.com/reddit/reddit)

0 commit comments

Comments
 (0)