Skip to content

Commit

Permalink
Merge branch 'main' of github.com:sagarpatel211/S-Lang
Browse files Browse the repository at this point in the history
Fixing merge conflict
  • Loading branch information
sagarpatel211 committed Jan 13, 2025
2 parents fd37a20 + c9a26f9 commit 3887c5a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Sagar Patel
Copyright (c) 2024 Sagar Patel

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
```diff
- PROJECT STILL IN PROGRESS!! CODEGEN LEFT, ADDING EXAMPLES, AND MINOR CHECKS FOUND BELOW
```

# Slanguage
<!-- BADGES -->
[![CMake](https://github.com/sagarpatel211/S-Lang/actions/workflows/cmake.yml/badge.svg?branch=main)](https://github.com/sagarpatel211/S-Lang/actions/workflows/cmake.yml)
Expand All @@ -10,38 +14,38 @@ A Programming Language for GenZ! I got into wanting to design my own programming
<!-- TABLE OF CONTENTS -->
## Table of Contents
- [To Do](#to-do)
- [Dependencies](#dependencies)
- [To Do](#to-do)
- [Project Structure](#project-structure)
- [Installation & Usage](#installation--usage)
- [Features](#features)
- [Examples](#examples)
- [Contributors](#contributors)


<!-- Dependencies AND TOOLS -->
<!-- DEPENDENCIES AND TOOLS -->
## Dependencies
- C++ Compiler (C++20 or later)
- CMake (3.16 or later)
- LLVM (14 or later)

## To Do
- Fix documentation of Parser.hpp
- Add documentation of Codegen.hpp
- Refactor Codegen.cpp (switch to snakecase, be consistent even though their API uses camelCase)
- Add documentation of Parser.cpp
- Add documentation of Codegen.cpp
- Complete test_parser
- Test if nested control flow statements work as well as multiple ong? (else-if) work
- Finish examples and their README and compile steps
- Finish this README
- Test it works on Windows and provide instructions in here
- Add a readthedocs page
- Make sure char and string concatenation work
- Double check global vars work
- Potentially add the @throws in the documentation for the parser, lexer, and codegen
- Test the examples work
- Add the Grammar of my code somewhere
- [ ] Fix documentation of Parser.hpp
- [ ] Add documentation of Codegen.hpp
- [ ] Refactor Codegen.cpp (switch to snakecase, be consistent even though their API uses camelCase)
- [ ] Add documentation of Parser.cpp
- [ ] Add documentation of Codegen.cpp
- [ ] Complete test_parser
- [ ] Test if nested control flow statements work as well as multiple ong? (else-if) work
- [ ] Finish examples and their README and compile steps
- [ ] Finish this README
- [ ] Test it works on Windows and provide instructions in here
- [ ] Add a readthedocs page
- [ ] Make sure char and string concatenation work
- [ ] Double check global vars work
- [ ] Potentially add the @throws in the documentation for the parser, lexer, and codegen
- [ ] Test the examples work
- [ ] Add the Grammar of my code somewhere


<!-- PROJECT STRUCTURE -->
Expand Down

0 comments on commit 3887c5a

Please sign in to comment.