Skip to content

Commit 3b134e0

Browse files
committed
misc readme update
1 parent 98448bd commit 3b134e0

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,22 @@ Online demo/compiler at <https://moonscript.org/compiler>.
1919

2020
## Join Our Community
2121

22-
We just created a Discord for those interested in MoonScript. You can join us here: <https://discord.gg/Y75ZXrD>
22+
We have a Discord for those interested in MoonScript and related projects. You can join us here: <https://discord.gg/Y75ZXrD>
23+
24+
## Contributing
25+
26+
MoonScript is a self-hosted compiler, meaning it's written in MoonScript itself. When contributing, please follow the following guidelines:
27+
28+
1. Edit `.moon` files, never modify the alongside `.lua` files directly
29+
2. After making changes to `.moon` files, run the compiler to regenerate the corresponding `.lua` files
30+
3. Both `.moon` and `.lua` files are included in the repository to ensure that:
31+
- Users can install and use MoonScript without having to compile it themselves
32+
- The compiler bootstrapping process works consistently
33+
34+
It's helpful to have a separate installation of MoonScript should you break
35+
something and you need to re-build the MoonScript with a working version of
36+
MoonScript. You can check out the repo in another directory, or install it
37+
using LuaRocks to have a separate working version.
2338

2439
## Running Tests
2540

@@ -34,7 +49,6 @@ busted
3449

3550
Writing specs is a bit more complicated. Check out [the spec writing guide](spec/README.md).
3651

37-
3852
## Binaries
3953

4054
Precompiled versions of MoonScript are provided for Windows. You can find them
@@ -53,7 +67,7 @@ branch](https://github.com/leafo/moonscript/tree/binaries)
5367

5468
## License (MIT)
5569

56-
Copyright (C) 2020 by Leaf Corcoran
70+
Copyright (C) 2025 by Leaf Corcoran
5771

5872
Permission is hereby granted, free of charge, to any person obtaining a copy
5973
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)