readmeupdate
This commit is contained in:
parent
8e82c0edbe
commit
ac606d2d13
68
Readme.md
68
Readme.md
@ -17,3 +17,71 @@ Tester
|
||||
Memory Checker
|
||||
sed command find gcc add " -g -fsanitize=address" directly after it
|
||||
catch fsanitize signals
|
||||
# Project Name
|
||||
Description\
|
||||
line 2\
|
||||
line 3\
|
||||
|
||||
---
|
||||
## Todo
|
||||
#### Write program
|
||||
- [x] Makefile
|
||||
- [ ] Functionality
|
||||
- [ ] Memory leaks
|
||||
- [ ] Norminette
|
||||
#### Write Tester
|
||||
- [ ] Norminette
|
||||
- [ ] Makefile
|
||||
- [ ] Relink
|
||||
- [ ] Wrong Input
|
||||
- [ ] Check Output
|
||||
- [ ] Return Values
|
||||
- [ ] Memory leaks
|
||||
|
||||
---
|
||||
## Improvements
|
||||
### Feature
|
||||
##### Program
|
||||
- Step 1
|
||||
- Step 2
|
||||
##### Program
|
||||
- Step 1
|
||||
- Step 2
|
||||
|
||||
---
|
||||
## Bugs
|
||||
**existing bug**
|
||||
*Maybe a feature*
|
||||
~~squashed~~
|
||||
|
||||
---
|
||||
## Usage
|
||||
1. Simply clone or download the repository
|
||||
2. Run `make` in the cloned directory
|
||||
3. Start the server with `./program` in the cloned directory
|
||||
|
||||
---
|
||||
## Tester
|
||||
- add valgrind to tester
|
||||
- check for -Wall -Werror -Wextra
|
||||
|
||||
#### Usage
|
||||
1. Download test.sh ....... directory
|
||||
2. Make the file executable `chmod +x test.sh`
|
||||
3. Run `./test.sh` to start the test
|
||||
|
||||
---
|
||||
[This project is part of the studies at 42](https://42.fr/en/homepage/)
|
||||
|
||||
![alt text](https://www.markdownguide.org/assets/images/tux.png)
|
||||
|
||||
| Syntax | Description |
|
||||
| ----------- | ----------- |
|
||||
| Header | Title |
|
||||
| Paragraph | Text |
|
||||
|
||||
```
|
||||
codeblock
|
||||
```
|
||||
|
||||
> blockquote
|
||||
|
Loading…
Reference in New Issue
Block a user