mirror of https://github.com/flysand7/ciabatta.git
Update readme.md
This commit is contained in:
parent
64191d2148
commit
520acb6fc4
|
@ -1,7 +1,5 @@
|
|||
|
||||
-------------------------------------------------------------------------------
|
||||
ABOUT
|
||||
-------------------------------------------------------------------------------
|
||||
# Ciabatta
|
||||
|
||||
Ciabatta - An implementation of cross-platform C standard library with the
|
||||
following goals:
|
||||
|
@ -9,14 +7,10 @@ following goals:
|
|||
- Providing C standard library that fully implements all C features. Some
|
||||
standard libraries lack many features of C11 and C23, like threads.h or
|
||||
aligned_alloc in case of msvcrt.
|
||||
|
||||
- Making standard library that is easy to port to other platforms, for example
|
||||
an embedded platform or a custom operating system.
|
||||
|
||||
- Allowing applications to debug and step into standard library functions
|
||||
|
||||
- Reasonably fast CRT compared to MSVCRT and glibc.
|
||||
|
||||
- Extend the possibilities of C standard library with commonly used
|
||||
functionality: implementing POSIX standard (including directories and
|
||||
sockets), capability for unicode processing.
|
||||
|
@ -29,45 +23,41 @@ Please note that as of today ciabatta is still during development and does not
|
|||
implement many of the features that need to be implemented. Using it at current
|
||||
time is discouraged.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
PLATFORM SUPPORT
|
||||
-------------------------------------------------------------------------------
|
||||
## Support
|
||||
|
||||
OS:
|
||||
- Win64
|
||||
Operating System:
|
||||
- Windows
|
||||
- Linux (planned)
|
||||
- ...? (not planned)
|
||||
|
||||
Processor Architecture:
|
||||
- x86-64
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
USING THE LIBRARY
|
||||
-------------------------------------------------------------------------------
|
||||
This library is supposed to be extensible to other platforms, meaning that
|
||||
you can write an OS layer for another OS and use the rest of the CRT
|
||||
functionality.
|
||||
|
||||
Using ciabatta with msvc is not supported. The only compiler that the library
|
||||
have been compiled and tested with is clang.
|
||||
## Building & Usage
|
||||
|
||||
Building ciabatta with MSVC is not supported. The only compiler that the
|
||||
library have been compiled and tested with is clang.
|
||||
|
||||
Note that the library can only be used with clang
|
||||
1. Run ./build.cmd to compile ciabatta
|
||||
1.5. (Optionally) Run `./test crt_functions` to make sure there are no errors
|
||||
2. Grab the following files into your project's directory:
|
||||
- The ./include folder
|
||||
- The ./ciabatta.lib archive file
|
||||
- The ./utf8.obj object file
|
||||
3. Add the following flags to your compilation command:
|
||||
-I ./include utf8.obj -nostdlib -mfma
|
||||
4. Don't forget to link to the following libraries:
|
||||
-lciabatta.lib
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
CONTRIBUTING
|
||||
-------------------------------------------------------------------------------
|
||||
1. Run ./build.cmd to compile ciabatta
|
||||
- (Optionally) Run `./test crt` to make sure there are no errors
|
||||
2. Grab the following files into your project's directory:
|
||||
- The `./include` folder
|
||||
- The `./ciabatta.lib` archive file
|
||||
- The `./utf8.obj` object file
|
||||
3. Add the following flags to your compilation command:
|
||||
`-I ./include utf8.obj -nostdlib -mfma`
|
||||
4. Don't forget to link to the following libraries:
|
||||
`-lciabatta.lib`
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests welcome and accepted in any form.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
LICENCE
|
||||
-------------------------------------------------------------------------------
|
||||
## License
|
||||
|
||||
TBD, but probably i'll make it MIT or WTFPL :kekw:
|
||||
TBD
|
Loading…
Reference in New Issue