Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xeptore/simple-fat-fs
Simple FAT File System Implementation
https://github.com/xeptore/simple-fat-fs
fat fat-fs
Last synced: about 2 months ago
JSON representation
Simple FAT File System Implementation
- Host: GitHub
- URL: https://github.com/xeptore/simple-fat-fs
- Owner: xeptore
- License: mit
- Created: 2020-12-05T04:31:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-09T07:07:31.000Z (almost 4 years ago)
- Last Synced: 2024-04-09T11:27:15.772Z (9 months ago)
- Topics: fat, fat-fs
- Language: C
- Homepage:
- Size: 198 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple FAT File System
University project educational-purpose simple (and naive!) FAT File System Implementation.
## Building
I personally used _Laynux_ and Clang, but I'm sure there are ways to build and run project on Windows as well, but I do not have time to test it on a real Windows machine.
1. [Download](https://cmake.org/download/) and install CMake for your operating system from [its website](https://cmake.org/).
2. Clone/download project:
If you have installed [git](https://git-scm.com/) on your computer, execute following command:
```sh
git clone [email protected]:xeptore/simple-fat-fs.git
```
This will download the repository. Then you can navigate to project's root directory by executing following command:
```sh
cd simple-fat-fs
```
If you do not have _git_, you can download repository from [here](https://github.com/xeptore/simple-fat-fs/archive/main.zip). Then extract the archive file and navigate to project's root directory.
3. Install a compiler:
You can use any compiler you'd like, I personally prefer Clang, but you can use GCC if you'd like to.
To download Clang go to [its official website](https://releases.llvm.org/download.html) and download the correct compiler for your operating system.
If you are on Linux machine, you can install it, if it's not already installed, using your distribution package manager.
4. Run CMake in the project's directory to generate `Makefile`
- Using command line:
```sh
cmake -S . -B build
```
If it throws error on failure to find compiler, change compiler path in `CMakeLists.txt` file via `CMAKE_C_COMPILER` variable value.
This will create a `build` subdirectory in project's root directory which contains files and directories alongside `Makefile`.
Execute following command to compile project:
```sh
make --directory=build
```
This command will generate `simple-fat` executable file in `build/` directory which is the main application executable, if succeeded.
## Usage
You can execute `simple-fat` executable with `--help` option to see all possible commands, their options and each option limitations in details.
## Testing
Alongside `simple-fat` executable file, there are other executables named in format `_test_`, e.g., `_test_fat` and `_test_directory`, which are testing executables and can be run separately from each other. Each one executes tests on its own library.
Also there are files in `src/` directory which are named in format `_test.c` that contain tests for `` library.