Skip to content

Commit 5059930

Browse files
authored
Update README.md
1 parent e2d37bd commit 5059930

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1-
# simple_password_checker
1+
# Simple password checker
22
:key: Simple password checker is implemented in C and NASM. Created to gain experience in zero runtime programming :key:
3+
4+
## ⚠️ LICENSE ⚠️
5+
MIT License
6+
7+
Copyright (c) 2022 m!haly4
8+
9+
Permission is hereby granted, free of charge, to any person obtaining a copy
10+
of this software and associated documentation files (the "Software"), to deal
11+
in the Software without restriction, including without limitation the rights
12+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13+
copies of the Software, and to permit persons to whom the Software is
14+
furnished to do so, subject to the following conditions:
15+
16+
The above copyright notice and this permission notice shall be included in all
17+
copies or substantial portions of the Software.
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25+
SOFTWARE.
26+
27+
## 💻 How to use this app 💻
28+
29+
1) ⚠️ **The application is designed for Linux, so avoid using other systems or remake the program to avoid bugs.** ⚠️
30+
2) 🗂️ Download *all* files and put them in a one directory.
31+
3) ⚒️ Compile the program with *nasm* and *clang* or *gcc*, whether you like.
32+
- Сompilation example:
33+
- first command
34+
```
35+
nasm -f elf start.asm
36+
37+
```
38+
- second command
39+
```
40+
nasm -f elf function_call.asm
41+
```
42+
- third command (creating a 32-bit object module *main.o*)
43+
```
44+
clang -m32 -c main.c
45+
```
46+
4) 💥 Then, in your directory will appear files *"main.o, function_call.o, start.o"*.
47+
- Command for linking files and creating a program
48+
```
49+
ld -m elf_i386 start.o function_call.o main.o -o main
50+
```
51+
5) 💥 Then, in your directory will appear file *"main"*.
52+
- If you want to check files in current directory
53+
```
54+
ls -alR
55+
```
56+
- Or
57+
```
58+
ls -a -l -R
59+
```
60+
6) 🌠 Execute the program with command:
61+
```
62+
./main <password>
63+
```
64+
- Example:
65+
```
66+
./main Hello
67+
```

0 commit comments

Comments
 (0)