Skip to content

Commit

Permalink
Add build openark doc, update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackINT3 committed Jul 14, 2020
1 parent dffd2a5 commit aabad2b
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 50 deletions.
40 changes: 16 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,8 @@

![License](https://img.shields.io/badge/License-LGPL-green.svg)

### Official Links
* Website: https://openark.blackint3.com/
* Source: https://github.com/BlackINT3/OpenArk/
* Manuals: https://openark.blackint3.com/manuals/
* QQ Group: 836208099

### Introduction
* [中文说明](https://github.com/BlackINT3/OpenArk/blob/master/doc/README-zh.md)
* [中文说明](doc/README-zh.md)

* OpenArk is a open source anti-rookit(Ark) tool on Windows. Ark is Anti Rootkit abbreviated, it aimmed at reversing and programming helper, users also can use it to find out malwares in the OS. More and more commands will be supported in future.

Expand All @@ -27,22 +21,20 @@
* Language - support English and Chinese now, more languages in future.
* More features in developing...

### Requirement
### Distributions
* Program: one exe binary, no dependence, support 32/64 bit.
* Supported OS: Windows XP ... Win7 ... Win10 2004 ...

### Compile
* [How To Build OpenArk](doc/build-openark.md)
* [UNONE & KNONE](https://github.com/BlackINT3/none) - User & Kernel mode BaseLibrary
* [Qt 5.6.2](https://download.qt.io/official_releases/qt/5.6/5.6.2/) - GUI Framework

### Distributions
* Binary (exe)
* one binary, no dependence, support 32/64 bit.
* Supported OS
* Windows XP/2003/Vista/7/2008/8/8.1/2012/10/2016/2019
* Supported Compiler
* Visual Studio 2015/2017/2019

### How to compile
* install UNONE static library, vs2015-unone.nupkg.
* install Qt static library.
* just build it, current is vs2015 project.

### Contributing
* Issues and Push request is welcome.
### Contributing/Donate
* Issues and Push Request is welcome.
* If you like that you can donate to our develop.

### Official Links
* Website: https://openark.blackint3.com/
* Source: https://github.com/BlackINT3/OpenArk/
* Manuals: https://openark.blackint3.com/manuals/
* QQ Group: 836208099
40 changes: 14 additions & 26 deletions doc/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,8 @@

![License](https://img.shields.io/badge/License-LGPL-green.svg)

### 官方链接
* 官方网站: https://openark.blackint3.com/
* 项目地址: https://github.com/BlackINT3/OpenArk/
* 帮助手册: https://openark.blackint3.com/manuals/
* QQ群: 836208099

### 简介
* [英文说明](https://github.com/BlackINT3/OpenArk/blob/master/README.md)
* [英文说明](../README.md)

  OpenArk是一款Windows平台上的开源Ark工具. Ark是Anti-Rootkit(对抗恶意程序)的简写, OpenArk目标成为逆向工程师、编程人员的工具,同时也能为那些希望清理恶意软件的用户服务。以后也将会支持更多功能和命令。
![image](resources/snapshot-zh-v106.png)
Expand All @@ -27,26 +21,20 @@
* 语言 - 目前支持中文和英文,以后会支持更多语言。
* 更多功能正在开发中。。。

### 依赖
* [UNONE & KNONE](https://github.com/BlackINT3/none) - 应用层&内核层基础库
* [Qt 5.6.2](https://download.qt.io/official_releases/qt/5.6/5.6.2/) - GUI开发框架

### 发布
* 二进制 (exe)
* 独立的exe,无DLL依赖,支持32位、64位。
* 支持的操作系统
* Windows XP/2003/Vista/7/2008/8/8.1/2012/10/2016/2019
* 支持的编译器
* Visual Studio 2015/2017/2019
* 程序:独立的exe,无DLL依赖,支持32位、64位。
* 支持系统:Windows XP ... Win7 ... Win10 2004 ...

### 如何编译
* 安装UNONE静态库Nuget包,例如VS2015:vs2015-unone.nupkg。
* 安装Qt静态库。
* 编译即可,目前是VS2015工程开发。
### 编译
* [如何编译OpenArk](build-openark.md)
* [UNONE & KNONE](https://github.com/BlackINT3/none) - 应用层和内核层的基础库

### 参与项目
* 欢迎提交Issue和PR.
### 参与/捐赠
* 欢迎提交Issue和PR.
* 如果你喜欢OpenArk,可以捐赠支持我们的开发工作。

* QQ群: 836208099

![](doc/resources/qq-qun.png)
### 官方链接
* 官方网站: https://openark.blackint3.com/
* 项目地址: https://github.com/BlackINT3/OpenArk/
* 帮助手册: https://openark.blackint3.com/manuals/
* QQ群: 836208099
28 changes: 28 additions & 0 deletions doc/build-openark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# How To Build OpenArk

### You need four steps just easily!

#### Install WDK
* Download WDK 7601 and install it
* Add user environment value WDKPATH that set value to WDK root directory, eg: C:\WINDDK\7600.16385.1

#### Install Visual Studio
* Download Visual Studio 2015 (recommend) and install it

#### Install Qt
* Download [qt5.6.2-static-lib.zip](http://nuget.blackint3.com:20001/qt5.6.2-static-lib.zip) and unzip it (you can also build by your self).
* Install qt extension of vs2015(tools/qt/qt-vsaddin-msvc2015-2.4.3.vsix)
* Specific the path, and (Qt Vs Tools - Qt Options) add qt-make32, qt-make64 versions
![](material/set-qt-version.png)

#### Add Nuget Package Repoistry
* Add nuget repoistry (VS Tools - Options - Nuget Package Manager - Package Sources)
* Name: NugetRepoServer
* Repoistry: http://nuget.blackint3.com:20001/api/odata
* OPTINAL: You can also install according to [NONE Manual](https://github.com/BlackINT3/none)

### Now go ahead, build it.

### Q&A
* Q: Build OpenArk driver, not found ntifs.h?
* A: Be sure WDKPATH environment setting ok, may be you should restart explorer and vs2015.
Binary file added doc/material/set-qt-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aabad2b

Please sign in to comment.