Fix serveral grammer issue in the README

This commit is contained in:
Sameer Rahmani 2023-02-03 16:12:50 +00:00
parent 42ec574484
commit b632d0a0e9
Signed by: lxsameer
GPG Key ID: B0A4AF28AB9FD90B
1 changed files with 12 additions and 11 deletions

View File

@ -33,6 +33,7 @@ welcome to port it to other platforms as well.
- Boehm GC v8.2.0
Check out the submodule under =deps/bdwgc=. If you're building this library yourself,
make sure to build in statically with ~-fPIC~ flag.
- zstd (Only if you want to use prebuilt dependencies on Linux)
** Setup development environment
Before, you have to set up the necessary git hooks as follows:
@ -60,24 +61,24 @@ all the dependencies as instructed above and follow:
#+END_SRC
After building or pulling the dependencies, you'll have all of them under =~/.serene/env/=.
All you need to do is to activate the environmet and build Serene itself.
All you need to do is to activate the environment and build Serene itself.
In order to activate the environment you can just do ~source ./activate~ in the root of the
To activate the environment, you can just do ~source ./activate~ in the root of the
source tree to activate the toolchain and the right set up dependencies.
** Build and installing dependencies (Other platforms)
At the moment the ~builder~ script does not support any platform beside GNU/Linux. So, you
Currently, the ~builder~ script does not support any platform beside GNU/Linux. So, you
need to build the dependencies yourself and make them available to the builder.
By the way, If you are interested, you can just hack the builder script and accommodate your
platform and contribute your changes to the project.
In order to build the dependencies in your platform, you can use the =./scripts/deps.sh= as
To build the dependencies in your platform, you can use the =./scripts/deps.sh= as
a reference.
* How to build
In order to build for development (Debug mode) just use =./builder build= to setup the build system,
To build for development (Debug mode) just use =./builder build= to setup the build system,
and build the project once, and then you can just use =./builder compile= to build the changed files
only.
@ -85,9 +86,9 @@ Check out the =builder= script for more subcommands and details.
** Head's up for devs
While you're working on *Serene* be mindful of:
- In =DEBUG= mode, we dynamically link against =libsan= due to the fact that we build the =libserene=
- In =DEBUG= mode, we dynamically link against =libsan= since we build the =libserene=
as a shared lib by default. This means we need to =LD_PRELOAD= the =libclang_rt= before we run
any executable. If you're using the =builder= script you're all set otherwise you can run an
any executable. If you're using the =builder= script, you're all set. Otherwise, you can run an
executable like:
#+BEGIN_SRC bash
@ -96,13 +97,13 @@ While you're working on *Serene* be mindful of:
** Build the devtools
We have our own version of `mlir-opt` which is `slir-opt` and also we have an LSP server for SLIR too.
Both are in the ~devtools~ directory and in order to build them all you need to do is to use
Both are in the ~devtools~ directory and in to build them all you need to do is to use
~-DSERENE_ENABLE_DEVTOOLS=ON~ parameter with cmake for example ~./builder build -DSERENE_ENABLE_DEVTOOLS=ON~
will do the job for you.
* How to Debug
Since we're using the Boehm GC, in order to use a debugger we need to turn off some of the signal
handlers that the debugger sets. In order to run the debugger (by default lldb) with ~serenec~
Since we're using the Boehm GC, to use a debugger, we need to turn off some of the signal
handlers that the debugger sets. To run the debugger (by default, lldb) with ~serenec~
just use the ~lldb-run~ subcommand of the builder script. In the debugger, after setting the
break point on the ~main~ function (~b main~) then use the following commands on:
@ -131,7 +132,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
* Get Help
If you need help or you just want to hangout, you can find us at:
If you need help, or you just want to hang out, you can find us at:
- *IRC*: *#serene-lang* on the libera chat server
- *MailingList*: https://www.freelists.org/list/serene