Skip to content

Commit 34fcbfc

Browse files
committed
Update README
1 parent 0065e7a commit 34fcbfc

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,50 @@
22

33
[![CI](https://github.com/gnustep/libs-xcode/actions/workflows/main.yml/badge.svg)](https://github.com/gnustep/libs-xcode/actions/workflows/main.yml?query=branch%3Amaster)
44

5-
1 README
6-
==
5+
## 1 README
76

8-
The GNUstep Xcode Library is a library for building xcode projects.
9-
It can be used to parse and provide information regarding an
7+
The GNUstep Xcode Library is a library for building xcode projects.
8+
It can be used to parse and provide information regarding an
109
xcode project or used to build an xcode project directly.
1110

12-
1.1 License
13-
===========
11+
### 1.1 License
1412

1513
The GNUstep libraries and library resources are covered under the GNU
16-
Lesser General Public License. This means you can use these libraries
17-
in any program (even non-free programs). If you distribute the libraries
18-
along with your program, you must make the improvements you have made to
14+
Lesser General Public License. This means you can use these libraries
15+
in any program (even non-free programs). If you distribute the libraries
16+
along with your program, you must make the improvements you have made to
1917
the libraries freely available. You should read the COPYING.LIB file for
20-
more information.
18+
more information.
2119

22-
1.2 How to use
23-
==============
20+
### 1.2 How to use
2421

2522
To use this library you need to build it and install it and then compile
2623
the front-end which is in the Tools directory and is called buildtool.
27-
Simply go into a directory which contains an Xcode project and type buildtool
24+
Simply go into a directory which contains an Xcode project and type buildtool
2825
and it should build the project. If it doesn't then submit a bug.
2926
Currently GNUstep can only build projects for macOS. Once support for UIKit and
3027
other frameworks are available, those will be added.
3128

32-
1.2.1 Plans for the future
33-
==========================
29+
#### 1.2.1 Plans for the future
3430

35-
* Create delegate which will provide a way for the library to
31+
* Create delegate which will provide a way for the library to
3632
execute callbacks into the caller so that information can be shown.
3733
This should eliminate the need to print anything in the library as all
3834
of the printing will be done on the front end based on information sent
3935
back by the library to the delegate.
40-
* Add more options to how the build is run so that the caller can specify
36+
* Add more options to how the build is run so that the caller can specify
4137
which target should be built.
42-
* Add support for translated to .pcproj files.
38+
* Add support for translated to .pcproj files.
4339

44-
1.2.2 Documentation
45-
===================
40+
#### 1.2.2 Documentation
41+
4642
I am working on a manual as well as gsdocs for the code so that the library is
47-
properly documented. There is a manual for buildtool.plist settings and other
43+
properly documented. There is a manual for buildtool.plist settings and other
4844
information in the Documentation directory of this project.
4945

50-
1.3 How can you help?
51-
=====================
46+
## 1.3 How can you help?
5247

53-
* Give us feedback! Tell us what you like; tell us what you think
48+
* Give us feedback! Tell us what you like; tell us what you think
5449
could be better.
5550

5651
Please log bug reports on the GNUstep project page
@@ -74,4 +69,3 @@ notice and this notice are preserved.
7469
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=gnustep/libs-xcode&type=Date" />
7570
</picture>
7671
</a>
77-

0 commit comments

Comments
 (0)