Skip to content

Commit eacfe65

Browse files
committed
Better README and clean gitignore
1 parent 2558529 commit eacfe65

File tree

2 files changed

+78
-5
lines changed

2 files changed

+78
-5
lines changed

.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,33 @@
2424
# Qt
2525
*.user
2626
*.qm
27+
28+
# Compiler Stuff
29+
/Makefile
30+
/Sachesi
31+
/moc_apps.cpp
32+
/moc_apps.cpp
33+
/moc_autoloaderwriter.cpp
34+
/moc_backupinfo.cpp
35+
/moc_blitzinfo.cpp
36+
/moc_boot.cpp
37+
/moc_carrierinfo.cpp
38+
/moc_deviceinfo.cpp
39+
/moc_discoveredrelease.cpp
40+
/moc_downloadinfo.cpp
41+
/moc_fs.cpp
42+
/moc_ifs.cpp
43+
/moc_installer.cpp
44+
/moc_mainnet.cpp
45+
/moc_qnx6.cpp
46+
/moc_quagzipfile.cpp
47+
/moc_quaziodevice.cpp
48+
/moc_quazipfile.cpp
49+
/moc_rcfs.cpp
50+
/moc_scanner.cpp
51+
/moc_splitter.cpp
52+
/moc_translator.cpp
53+
/qrc_UI.cpp
54+
/qrc_translations.cpp
55+
56+

README.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Sachesi
2-
=======
1+
# Sachesi
32

43
Introducing Sachesi. The results of my continued work on firmware tools for Blackberry 10 and Playbook.
54

@@ -10,8 +9,8 @@ The application mimics communications performed by official Blackberry tools and
109

1110
Developed by Sacha Refshauge. Project originally known as Dingleberry. Public release of source code on May 26, 2014.
1211

13-
Build Instructions
14-
==================
12+
13+
## Build Instructions
1514

1615
Technically should work on all operating systems that support Qt. This project works with both dynamic and static builds of Qt4.8+ and Qt5.0+.
1716
It is known to build and has built binaries available for desktop platforms: Windows XP+, Linux, Mac OSX 10.5+. It can also build and run a restricted subset of activities on mobile platforms: Symbian, Android and Blackberry 10. To upgrade firmware via a mobile device requires USB low-level access (host device must support network usb drivers), such as Symbian and possibly rooted Android devices.
@@ -20,4 +19,48 @@ This project requires miniLZO, zlib-1.2.8, QuaZIP and OpenSSL.
2019
For Linux and Mac, the project optionally uses libusb-1.0 for bootloader activities.
2120
For your convenience, a snapshot of the important files from libusb-1.0, miniLZO, zlib-1.2.8 and QuaZIP have been provided. OpenSSL for Android is also provided.
2221

23-
On Windows, you will need to install OpenSSL to C:\openssl
22+
23+
## Windows Build Instructions (MinGW)
24+
25+
1. Install latest QT with MinGW from [qt-project.org](https://qt-project.org).
26+
2. Install OpenSSL to `C:\OpenSSL` from [http://www.wittfella.com/openssl](http://www.wittfella.com/openssl).
27+
3. Open Sachesi.pro in QtCreator.
28+
4. Adjust the hardcoded paths set in `QML.qrc` to point to the correct qml files.
29+
5. Run.
30+
31+
**Notes for Visual Studio**:
32+
33+
- Use [this precompiled OpenSSL](http://www.npcglib.org/~stathis/blog/precompiled-openssl) version.
34+
35+
36+
## Ubuntu Build Instructions
37+
38+
1. Install the required dependencies:
39+
40+
```bash
41+
sudo apt-get install qt5-qmake libqt5network5 libqt5qml5 qtdeclarative5-settings-plugin qtdeclarative5-controls-plugin qtdeclarative5-dialogs-plugin qtdeclarative5-quicklayouts-plugin qtdeclarative5-window-plugin qtdeclarative5-qtquick2-plugin qttools5-dev-tools libssl-dev qtdeclarative5-dev libusb-1.0-0-dev
42+
```
43+
44+
2. Compile Sachesi:
45+
46+
```bash
47+
cd /path/to/Sachesi;
48+
qmake;
49+
make -j4;
50+
```
51+
52+
**Common Errors**
53+
54+
On some systems there might be some `Cannot find file translations/...` errors. This can
55+
be fixed by executing `make compiler_lang_make_all` and executing the above steps again.
56+
57+
58+
## OSX Build Instructions
59+
60+
1. Install latest XCode.
61+
2. Install latest QT from [qt-project.org](https://qt-project.org).
62+
3. Install `brew` from [brew.sh](https://brew.sh).
63+
4. Run `brew install libusb`.
64+
5. Open Sachesi.pro in QtCreator.
65+
6. Run.
66+

0 commit comments

Comments
 (0)