Railostools - Revision history

Krizar: /* Python */

2023-05-16T21:59:52Z

Python

Krizar: /* Python */

2023-05-16T21:59:25Z

Python

Krizar: Add Python module install

2023-05-16T21:58:40Z

Add Python module install

Krizar at 10:16, 14 January 2023

2023-01-14T10:16:05Z

Krizar: Started C++ guide

2023-01-14T09:45:17Z

Started C++ guide

Krizar at 20:21, 24 August 2022

2022-08-24T20:21:38Z

Krizar at 20:15, 24 August 2022

2022-08-24T20:15:29Z

Krizar at 20:15, 24 August 2022

2022-08-24T20:15:03Z

Daniel: Daniel moved page Rostools to Railostools

2022-04-08T02:35:37Z

Daniel moved page Rostools to Railostools

Daniel: Changed file links

2022-04-08T02:35:02Z

Changed file links

@@ Line 3: / Line 3: @@
 == Python ==
-The Python module can be found within the <code>python</code> directory of the railostools repository. The module can be installed using <code>pip</code> referring to the repository as the source (replacing <code><release-tag></code> with the latest release [https://github.com/Railway-Op-Sim/railostools/releases/latest here]:
+The Python module can be found within the <code>python</code> directory of the railostools repository. The module can be installed using <code>pip</code> referring to the repository as the source (replacing <code><release-tag></code> with the latest release [https://github.com/Railway-Op-Sim/railostools/releases/latest here]):
 <pre>

@@ Line 7: / Line 7: @@
 <pre>
 $ pip install "git+https://github.com/Railway-Op-Sim/railostools.git#egg=<release-tag>&subdirectory=python"
-<pre>
+</pre>
 == C++ ==

@@ Line 1: / Line 1: @@
 '''railostools''' is a set of Application Programming Interfaces for [[Railway Operation Simulator]] with implementations written in Python, C++, Java and Rust. Features for each implementation vary, but include libraries for constructing and parsing [[metadata file|metadata files]], [[.rly file|railway]] and [[.ttb file|timetable]] files. The source code is available on the [[Developer GitHub Organisation|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.
 == C++ ==
-The C++ library can be found in the <code>cpp</code> directory of the railostools repository. The framework requires a compiler which supports C++17 or greater, and has been tested on both GCC and Clang for Windows, macOS and Linux. It is recommended that the repository be added as a submodule in git to your project:
+The C++ library can be found within the <code>cpp</code> directory of the railostools repository. The framework requires a compiler which supports C++17 or greater, and has been tested on both GCC and Clang for Windows, macOS and Linux. It is recommended that the repository be added as a submodule in git to your project:
 <pre>

@@ Line 28: / Line 28: @@
 target_include_directories( ${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/external/railostools/cpp/include )
 </pre>
 [[Category:External tools]]

← Older revision		Revision as of 09:45, 14 January 2023
Line 1:		Line 1:
	'''railostools''' is a set of Application Programming Interfaces for [[Railway Operation Simulator]] with implementations written in Python, C++, Java and Rust. Features for each implementation vary, but include libraries for constructing and parsing [[metadata file\|metadata files]], [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[Developer GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.		'''railostools''' is a set of Application Programming Interfaces for [[Railway Operation Simulator]] with implementations written in Python, C++, Java and Rust. Features for each implementation vary, but include libraries for constructing and parsing [[metadata file\|metadata files]], [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[Developer GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.
		+
		+	== C++ ==
		+
		+	The C++ library can be found in the <code>cpp</code> directory of the railostools repository. The framework requires a compiler which supports C++17 or greater, and has been tested on both GCC and Clang for Windows, macOS and Linux. It is recommended that the repository be added as a submodule in git to your project:
		+
		+	<pre>
		+	$ mkdir external
		+	$ git submodule add https://github.com/Railway-Op-Sim/railostools.git external/railostools
		+	</pre>
		+
		+	and the library be linked using CMake:
		+	<pre>
		+	cmake_minimum_required( VERSION 3.21 )
		+	set( CMAKE_CXX_STANDARD 17 )
		+	set( CMAKE_CXX_STANDARD_REQUIRED True )
		+	set( RAILOSTOOLS railostools )
		+
		+	project( MyProject VERSION 0.1.0 LANGUAGES CXX )
		+
		+	# E.g. find all project source files (in 'src' directory with .cxx suffix) to compile code
		+	file( PROJECT_SRC_FILES ${CMAKE_CURRENT_SOURCE_DIR}/src*.cxx )
		+
		+	add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/external/railostools/cpp )
		+
		+	add_executable( ${PROJECT_NAME} ${PROJECT_SRC_FILES} )
		+	target_link_library( ${PROJECT_NAME} PUBLIC ${RAILOSTOOLS} )
		+	target_include_directories( ${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/external/railostools/cpp/include )
		+	</pre>

	[[Category:External tools]]		[[Category:External tools]]

← Older revision		Revision as of 20:21, 24 August 2022
Line 1:		Line 1:
−	'''railostools''' is a set of ~~programming tools~~ written in Python, C++ and ~~Java designed~~ for ~~aiding in writing software~~ for ~~[[Railway Operation Simulator]]. Included are tools for dealing with a~~ [[metadata file]], ~~and parsing~~ [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[Developer GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.	+	'''railostools''' is a set of Application Programming Interfaces for [[Railway Operation Simulator]] with implementations written in Python, C++, Java and Rust. Features for each implementation vary, but include libraries for constructing and parsing [[metadata file\|metadata files]], [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[Developer GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.

	[[Category:External tools]]		[[Category:External tools]]

← Older revision		Revision as of 20:15, 24 August 2022
Line 1:		Line 1:
−	'''railostools''' is a set of programming tools written in Python, C++ and Java designed for aiding in writing software for [[Railway Operation Simulator]]. Included are tools for dealing with a [[metadata file]], and parsing [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[~~Development~~ GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.	+	'''railostools''' is a set of programming tools written in Python, C++ and Java designed for aiding in writing software for [[Railway Operation Simulator]]. Included are tools for dealing with a [[metadata file]], and parsing [[.rly file\|railway]] and [[.ttb file\|timetable]] files. The source code is available on the [[Developer GitHub Organisation\|Railway-Op-Sim GitHub Organisation]] and the project can be contributed to by anyone.

	[[Category:External tools]]		[[Category:External tools]]

← Older revision	Revision as of 02:35, 8 April 2022
(No difference)