Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add extra markdown formatting for better understanding #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add extra markdown formatting for better understanding #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 104 additions & 99 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,129 @@
Space Invaders Clone
# Space Invaders Clone

This is an example to illustrate Entity_ Component System.

## Release Notes

# Release Notes
Version| Description
--------|------------
0.0.8 | Bolt LifeSpan (Time)
0.0.7 | Background moves as ship thrust up with Up Arrow Key
0.0.6 | ???
0.0.5 | ???
0.0.4 | ???
0.0.3 | ???
0.0.2 | LoadTexture, CreateTextureWithSize and DestroyTexture
0.0.1 | First Sample for a Rectangle Texture Rendered
0.0.0 | Starting version

Version -- Description
## Not official Installation Instruction (Thanks José de Paz)

### Prerequisites

0.0.8 -- Bolt LifeSpan (Time).
- Following steps are made using **cmake 3.10**
- Check versions and availiability. Install if needed
- `g++ --version`
- `cmake --version`

0.0.7 -- Background moves as ship thrust up with Up Arrow Key

0.0.6 -- ???

0.0.5 -- ???

0.0.4 -- ???

0.0.3 -- ???

0.0.2 -- LoadTexture, CreateTextureWithSize and DestroyTexture.

0.0.1 -- First Sample for a Rectangle Texture Rendered.

0.0.0 -- Starting version.


# Not official Installation Instruction (Thanks José de Paz)

- Compiling using g++ 7 and cmake 3.10
### Steps

0. Install dependent libraries:

libpng-dev (or libpng-devel in OpenSuse )
xorg-dev (or xorg-x11-devel in OpenSuse )
libasound2-dev (or alsa-dev in OpenSuse )
pulseaudio

(*** libs for SDL2 -- look at the result of the "./configure" command --)
libsamplerate
libudev
dbus
ime
ibus
fcitx


1. Download SDL, SDL_IMAGE and GLM packages:

SDL2-2.0.8.zip
SDL2_image-2.0.3.zip
glm-0.9.7.5.zip

2. Compile and install SDL2-2.0.8:
- decompress SDL2-2.0.8.zip
- enter the "SDL2-2.0.8" folder
- run "./configure" (***)
- run "make"
- run "make install" (with sudo privileges)

3. Compile and install SDL2_image-2.0.3:
- decompress SDL2_image-2.0.3.zip
- enter the "SDL2_image-2.0.3" folder
- run "./configure"
- run make
- run make install (with sudo privileges)

4. Compile and install glm-0.9.7.6:
- decompress glm-0.9.7.6.zip
- create folder "build"
- enter the "build" folder
- run "cmake .."
- run "make"
- run "make install" (with sudo privileges)

5. Modify "martin-the-martian" files:

- Open the "CMakeLists.txt" file and modify:
- comment the line "include(cmake/SDL.cmake)"
- comment the line "include(cmake/MacOS.cmake)"
- comment the next lines:
- **libpng-dev** (or **libpng-devel** in OpenSuse)
- **xorg-dev** (or **xorg-x11-devel** in OpenSuse)
- **libasound2-dev** (or **alsa-dev** in OpenSuse)
- **pulseaudio**
- **libs for SDL2** (_look at the result of the `./configure` command_)
- libsamplerate
- libudev
- dbus
- ime
- ibus
- fcitx

1. Download **SDL, SDL_IMAGE** and **GLM** packages:
- SDL2-2.0.8.zip
- SDL2_image-2.0.3.zip
- glm-0.9.7.5.zip

1. Compile and install **SDL2-2.0.8**:
- Decompress SDL2-2.0.8.zip
- Enter the "SDL2-2.0.8" folder
- Run `./configure` (***)
- Run `make`
- Run `make install` (_with sudo privileges_)

1. Compile and install **SDL2_image-2.0.3**:
- Decompress SDL2_image-2.0.3.zip
- Enter the "SDL2_image-2.0.3" folder
- Run `./configure`
- Run `make`
- Run `make install` (_with sudo privileges_)

1. Compile and install **glm-0.9.7.6**:
- Decompress glm-0.9.7.6.zip
- Create folder "build"
- Enter the "build" folder
- Run `cmake ..`
- Run `make`
- Run `make install` (_with sudo privileges_)

1. Modify **martin-the-martian** files:
- Open the **CMakeLists.txt** file and modify:
- Comment the line (_prefixing it with #_):
```cmake
include(cmake/SDL.cmake)
```
- Comment the line:
```cmake
include(cmake/MacOS.cmake)
```
- Comment the next lines:
```cmake
PrintLine()
HeaderMessage("SDL2 Libraries Linkage Addition")
SDL_LINK(${ProjectName})

PrintLine()
HeaderMessage("Cocoa Frameworks Linkage Addition")
COCOA_LINK(${ProjectName})
```
- save the file.

- Open the "cmake/Sources.cmake" file and modify:
- modify the line:

- Open the **cmake/Sources.cmake** file and modify:
- modify the line:
```cmake
target_link_libraries(${ProjectName} "-liconv" "-lm")

with this values:

```
with this value:
```cmake
target_link_libraries(${ProjectName} "-lSDL2" "-lSDL2_image" "-lm")
- save the file.
```
- save the file.

- Open the "src/sdlwrapper.cpp" file and modify:
- modify the line:
- Open the **src/sdlwrapper.cpp** file and modify:
- modify the line:
```cpp
#include <SDL2_image/SDL_image.h>

with this values:
```
with this value:
```cpp
#include <SDL2/SDL_image.h>
- save the file.

- Open the "src/Sprite.h" file and modify:
- modify the line:
#include <SDL2_image/SDL_image.h>
```
- save the file.

with this values:
- Open the **src/Sprite.h** file and modify:
- modify the line:
```cpp
#include <SDL2_image/SDL_image.h>
```
with this value:
```cpp
#include <SDL2/SDL_image.h>
- save the file.

6. Compile "martin-the-martian" project:

- create folder "build"
- enter the "build" folder
- run "cmake .."
- run "make"
- run "./VoidSample
```
- save the file.
1. Compile **martin-the-martian** project:
- Create folder "build"
- Enter the "build" folder
- Run `cmake ..`
- Run `make`
- Run `./VoidSample`