From 58b5838da9726bf39163e15e9f207a7f3fc45c31 Mon Sep 17 00:00:00 2001 From: Stinkfist0 Date: Sat, 20 Feb 2016 00:43:35 +0200 Subject: [PATCH] README.md tweaks --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 19c0f29b24..c320658ab7 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,19 @@ IfcOpenShell ============ -IfcOpenShell is an open source (LGPL) software library for working with the IFC ([IFC2x3 TC1] and [IFC4]) file format. - -[http://ifcopenshell.org](http://ifcopenshell.org) -[http://academy.ifcopenshell.org](http://academy.ifcopenshell.org) - +IfcOpenShell is an open source ([LGPL]) software library for working with the [IFC] ([IFC2x3 TC1] and [IFC4]) file format. +For more information, see +* [http://ifcopenshell.org](http://ifcopenshell.org) +* [http://academy.ifcopenshell.org](http://academy.ifcopenshell.org) Prerequisites -============= +------------- * Git * CMake (2.6 or newer) * Windows: Visual Studio 2008 or newer with C++ toolset, MinGW not supported currently * *nix: GCC 4.7 or newer, or Clang (any version should work, but not tested) - Dependencies -============ +------------- * [Boost](http://www.boost.org/) * Open Cascade - *optional*, but required for building IfcGeom ([official](http://www.opencascade.org/getocc/download/loadocc/) or [community edition](https://github.com/tpaviot/oce)) @@ -30,9 +28,9 @@ Dependencies For building the 3ds Max plug-in. All recent versions of 3ds Max (2014 and newer) are 64-bit only, so a 64-bit installation is assumed. - -Compiling on Windows -==================== +Building IfcOpenShell +--------------------- +### Compiling on Windows The preferred way to fetch and build this project's dependencies is to use the build scripts in win/ folder. **See [win/readme.md] for more information**. Instructions in a nutshell (**assuming Visual Studio 2015 x64 environment variables set**): @@ -55,8 +53,7 @@ Alternatively, one can use the utility batch files to build and install the proj > build-ifcopenshell.cmd > install-ifcopenshell.cmd -Compiling on *nix -================= +### Compiling on *nix There might be an Open CASCADE package in your operating system's software repository. If not, you will need to compile Open CASCADE yourself. See http://opencascade.org. @@ -90,7 +87,7 @@ To build IfcOpenShell please take the following steps: If all worked out correctly you can now use IfcOpenShell. See the examples below. Usage examples -============== +-------------- **Invoking IfcConvert from the command line** @@ -160,6 +157,8 @@ Usage examples >>> # Writing IFC-SPF files to disk: >>> f.write("out.ifc") -[win/readme.md]: https://github.com/IfcOpenShell/IfcOpenShell/tree/master/win/readme.md "win/readme.md" +[LGPL]: https://github.com/IfcOpenShell/IfcOpenShell/tree/master/COPYING "LGPL" +[IFC]: http://www.buildingsmart-tech.org/specifications/ifc-overview "IFC" [IFC2x3 TC1]: http://www.buildingsmart-tech.org/specifications/ifc-releases/ifc2x3-tc1-release "IFC2x3 TC1" -[IFC4]: http://www.buildingsmart-tech.org/specifications/ifc-releases/ifc4-release "IFC4" \ No newline at end of file +[IFC4]: http://www.buildingsmart-tech.org/specifications/ifc-releases/ifc4-release "IFC4" +[win/readme.md]: https://github.com/IfcOpenShell/IfcOpenShell/tree/master/win/readme.md "win/readme.md" \ No newline at end of file