Skip to content

Commit

Permalink
Merge pull request #94 from sotch-pr35mac/staging
Browse files Browse the repository at this point in the history
Staging v1.1.0
  • Loading branch information
sotch-pr35mac authored Feb 7, 2018
2 parents c921e8e + c3ac16c commit 2df4afa
Show file tree
Hide file tree
Showing 9,562 changed files with 20,850 additions and 120,383 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Change Log
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).

## [1.1.0] - 2018-02-07
### Added
- Text to Speech support as described in Issue #67
- Character Stroke Animations as described in Issue #90

### Fixed
- Duplicates in search results as described in Issue #85
- Issue with searching for pinyin with tone numbers
- Missing capital letter pinyin as described in Issue #86

### Changed
- Updated to a newer version of CC-CEDICT (Released 2018-02-07)
- Changed fields in dictionary database (app/src/db/cc-cedict.json)

## [1.0.1] - 2017-12-08
### Changed
- Moved prettify-pinyin to Rust (in syng-dictionary-creator)
Expand Down
54 changes: 19 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# __Syng | 词应__
##### Dictionary App | 词典应用
##### v1.0.1
##### v1.1.0
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

---

## __About__
Syng is a free, open source, Chinese-To-English and English-To-Chinese Dictionary app that makes it easy to lookup words and phrases quickly. Currently Syng works on macOS, Windows, and Linux systems.
Syng is a free, open source, Chinese-To-English and English-To-Chinese Dictionary app that makes it easy to lookup words and phrases quickly. Currently Syng works on macOS, Windows, and Linux systems.

### Name
Syng is a stylized spelling of cíyīng, the Pinyin for 词应. 词应 has been shorted from 词典应用, literally translating to Dictionary App.
Expand All @@ -20,7 +20,7 @@ Syng is a stylized spelling of cíyīng, the Pinyin for 词应. 词应 has been
- ___Bookmarks___
- Syng allows you to save words and searches to your bookmarks, so that you can reference them later, and even create custom vocab lists.
- __Offline Support__
- No internet connection required!
- No internet connection required for most features
- __Cross-Platform__
- Mac OS X
- Windows
Expand All @@ -31,19 +31,17 @@ Syng is a stylized spelling of cíyīng, the Pinyin for 词应. 词应 has been
- Convert between traditional and simplified characters
- __Pinyinify__
- Convert 汉字 into hànzì. Turn characters into pinyin
- __Character Stroke Animations__
- View character stroke order animations to study writing characters

## __What's new?__
Syng v1.0.0 is the biggest release yet, with some welcome new changes. For a full list of changes, see [the changelog](https://github.com/sotch-pr35mac/syng/blob/master/CHANGELOG.md).
1. Brand new user interface
2. 70% faster load time
3. Custom vocabulary lists
4. Notes
5. New Icon
6. Pinyinify characters
7. General stability and performance updates
Syng v1.1.0 includes a few new features and several bug fixes. For a full list of changes, see [the changelog](https://github.com/sotch-pr35mac/syng/blob/master/CHANGELOG.md).
1. Audio Pronunciation
2. Character Stroke Animations

## __Screenshots__
More screenshots available on [the Syng website](http://syngdict.com).

![image](./assets/homescreen.png)

## __Installing__
Expand All @@ -52,11 +50,11 @@ To install Syng on Linux, you can you use the pre-built installation script by c

For 64-bit systems:
```
wget -O- https://goo.gl/ybn3yz | bash
wget -O- https://goo.gl/ybn3yz | bash
```
For 32-bit systems:
For 32-bit systems:
```
wget -O- https://goo.gl/bjguUb | bash
wget -O- https://goo.gl/bjguUb | bash
```

Alternatively, if you aren't comfortable running the pre-built installation script, you can install manually by downloading the 64-bit candidate [here](https://github.com/sotch-pr35mac/syng/releases/download/v1.0.1/Syng-linux-x64.tar.gz) and the 32-bit candidate [here](https://github.com/sotch-pr35mac/syng/releases/download/v1.0.1/Syng-linux-ia32.tar.gz) and then following the installation instructions provided.
Expand All @@ -80,31 +78,17 @@ To install Syng on Windows, you can download the 64-bit installer from [here](ht
- Modified to work using hashmaps and support English, and pinyin search functionality.
- [Franc](https://github.com/wooorm/franc)
- Language Detection for Search
- [hanzi-writer](https://github.com/chanind/hanzi-writer) by [chanind](https://github.com/chanind)
- Character Stroke Animations

## __Developers Welcome__
If you're interested in contributing to Syng, you can checkout [the Roadmap](https://github.com/sotch-pr35mac/syng/blob/master/ROADMAP.md), or feel free to [contact me](mailto://[email protected]) and we can build great software together.

## __Contribute__
This is a [Commitizen Friendly](https://github.com/commitizen/cz-cli) Repository. When contributing please use commitizen when committing changes.
You can install commitizen using npm:
```
npm install -g commitizen
```
1. Fork it!
2. Create a branch `git checkout -b my-feature`
3. Commit your changes `git cz`
4. Submit a pull request
If you're interested in contributing to Syng, you can checkout [the Roadmap](https://github.com/sotch-pr35mac/syng/wiki/Roadmap), or feel free to [contact me](mailto://[email protected]) and we can build great software together.

## __Getting Started__
1. First go to the project directory
`cd /path/to/project/`
2. Install the dependencies
`npm install`
3. Run Syng
`npm start`
## __Contributing / Getting Started__
If you're interested in contributing to Syng, you can find a guide to getting started [here](https://github.com/sotch-pr35mac/syng/wiki/Getting-Started) in the [Syng wiki](https://github.com/sotch-pr35mac/syng/wiki). This guide outlines the development stack, project structure, and how to create a feature branch.

## __Contributors__
## __Maintainers__
- [Preston Wang-Stosur-Bassett](http://www.stosur.info)

## __License__
This software is licensed under the [GNU Public License 3](https://www.gnu.org/licenses/gpl-3.0.en.html).
This software is licensed under the [GNU Public License 3](https://www.gnu.org/licenses/gpl-3.0.en.html). The file at `app/src/db/cc-cedict.json` is licensed under the [Creative Commons Attribution-Share Alike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/).
18 changes: 0 additions & 18 deletions ROADMAP.md

This file was deleted.

5 changes: 4 additions & 1 deletion app/src/component/bookmarks/bookmarks.vue
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
<Icon type="arrow-expand" size="large"></Icon>
</Tooltip>
</i-button>
<tts v-bind:chars="currentWord.traditional"></tts>
</Button-group>
</div>
<h1 style="margin-bottom: 0px;">
Expand Down Expand Up @@ -215,6 +216,7 @@
<script>
var databaseManager = new window.DatMan();
var Notes = require('./notes.vue');
var Tts = require('../common/tts/tts.vue');
var _ = require('underscore');
// Generate unqiue random ID's for the word listings expanded content to be linked with the expanded content
Expand Down Expand Up @@ -297,7 +299,8 @@ module.exports = {
};
},
components: {
'notes': Notes
'notes': Notes,
'tts': Tts
},
events: {
'saveNotes': function(notes) {
Expand Down
35 changes: 35 additions & 0 deletions app/src/component/common/tts/tts.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<template>
<i-button v-on:click="speak()" v-if="networkStatus">
<Tooltip placement="left" content="Say Word (Requires Network Connection)">
<Icon type="volume-high" size="large"></Icon>
</Tooltip>
</i-button>
</template>

<style scoped>
</style>

<script>
var ttsmanager = new window.TTSManager([window.BaiduSpeaker]);
module.exports = {
props: [ 'chars' ],
data: function() {
return {
networkStatus: navigator.onLine
}
},
methods: {
speak: function() {
var self = this;
if(navigator.onLine) {
ttsmanager.speak(self.chars);
} else {
self.networkStatus = false;
self.$Message.error("Not connected to the internet! A netork connection is required to speak the word aloud.");
}
}
}
}
</script>
13 changes: 13 additions & 0 deletions app/src/component/search/search.vue
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
<Icon type="arrow-expand" size="large"></Icon>
</Tooltip>
</i-button>
<tts v-bind:chars="currentWord.traditional"></tts>
</Button-group>
</div>
<h1 style="margin-bottom: 0px;">
Expand Down Expand Up @@ -223,6 +224,8 @@ var _ = window.require('underscore');
var databaseManager = new window.DatMan();
var Tts = require('../common/tts/tts.vue');
module.exports = {
data: function() {
return {
Expand Down Expand Up @@ -258,6 +261,9 @@ module.exports = {
self.switchInputMethod();
});
},
components: {
'tts': Tts
},
methods: {
switchInputMethod: function() {
if(this.inputMethod == ENGLISH_INPUT) {
Expand Down Expand Up @@ -408,6 +414,13 @@ module.exports = {
});
});
// Remove duplicates from the search results
compiledResults = compiledResults.filter((compiledResult, index, self) =>
index === self.findIndex((w) => (
w.traditional === compiledResult.traditional && w.pinyin === compiledResult.pinyin
))
);
return compiledResults;
}
Expand Down
2 changes: 1 addition & 1 deletion app/src/component/study/flashcards/selector.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<style>
.selector-menu {
position: absolute;;
position: absolute;
top: 40vh;
left: 40vh;
}
Expand Down
3 changes: 2 additions & 1 deletion app/src/component/syngMenu/aboutSyng/aboutSyng.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img src="../style/img/syng-logo.png" height="120px" width="120px">
<h2>Syng | 词应</h2>
<h3>Dictionary App | 词典应用</h3>
<h4>v1.0.1</h4>
<h4>v1.1.0</h4>
</center>
<br>
<br>
Expand All @@ -24,6 +24,7 @@
<li><b>IView UI:</b> User Interface Framework</li>
<li><b>node-cc-cedict:</b> Syng uses a heavily modified version of John Heroy's node-cc-cedict project for using Node.js to query the CC-CEDICT database.</li>
<li><b>Franc:</b> Language Detection for Search</li>
<li><b>hanzi-writer:</b> Stroke Order Animations</li>
</ul>
</p>
<br>
Expand Down
38 changes: 38 additions & 0 deletions app/src/component/syngMenu/settings/language.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<template>
<div>
<Row>
<i-col span="16">
<h2 class="item-label">Interface Language</h2>
</i-col>
<i-col span="8">
<i-select :model.sync="language" placeholder="Language Preference" :on-change="">
<i-option value="en">English</i-option>
<i-option value="cn" :on-click="changeLanguage()">中文</i-option>
</i-select>
</i-col>
</Row>
</div>
</template>

<style>
.item-label {
font-size: 1.5em;
font-weight: normal;
}
</style>

<script>
module.exports = {
data: function() {
return {
language: ''
}
},
attached: function() {
},
methods: {
changeLanguage: function() {
}
}
}
</script>
24 changes: 18 additions & 6 deletions app/src/component/syngMenu/settings/settings.vue
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
<style>
</style>

<template>
<center>
<h1>SETTINGS</h1>
</center>
<div id="settings-panel">
<center>
<h2>Settings</h2>
</center>
<br>
<language></language>
</div>
</template>

<style>
#settings-panel {
padding: 25px;
}
</style>

<script>
var Language = require('./language.vue');
module.exports = {
data: function() {
return {}
},
components: {
language: Language
}
};
</script>
4 changes: 2 additions & 2 deletions app/src/component/syngMenu/syngMenu.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<h2>About</h2>
</center>
</Menu-item>
<!-- Settings Menu not implimented in this version -->
<!-- Settings menu not implmented in this version -->
<!--
<Menu-item key="2" v-on:click='loadView("settings")'>
<center>
<h2>Settings</h2>
</center>
</Menu-item>
-->
-->
<Menu-item key="3" v-on:click='loadView("viewLicense")'>
<center>
<h2>View Licenses</h2>
Expand Down
Loading

0 comments on commit 2df4afa

Please sign in to comment.